Debugging/it

Prerequisiti:

• pacchetto software gdb installato
• un debug build di FreeCAD (in questo momento disponibili solo per la compilazione di Debug)
• un modello di FreeCAD che causa un crash

Passaggi:

Immettere quanto segue nella finestra del terminale:

Trovare il codice binario di FreeCAD sul proprio sistema:

$ whereis freecad
freecad: /usr/local/freecad <--- for example

$ cd /usr/local/freecad/bin
$ gdb FreeCAD

LLDB produrrà alcune informazioni di inizializzazione. Il (lldb) mostra che il debugger è in esecuzione nel terminale, ora inserisci::

(gdb) handle SIG33 noprint nostop
(gdb) run

FreeCAD verrà avviato. Effettuare le operazioni che causano il crash o il blocco di FreeCAD, quindi immettere 'bt' nella finestra del terminale.

(gdb) bt

Questo genera una lunga lista che descrive esattamente ciò che il programma stava facendo quando è andato in crash o in blocco. Includere questa lista nel vostro rapporto sul problema.

(gdb) bt full

Stampa anche i valori delle variabili locali. Questo può essere combinato con un numero per limitare il numero di frame mostrati.

Prerequisiti:

• pacchetto software lldb installato
• un debug build di FreeCAD
• un modello di FreeCAD che causa un crash

Passaggi:

Immettere quanto segue nella finestra del terminale:

$ cd FreeCAD/bin
$ lldb FreeCAD

LLDB produrrà alcune informazioni di inizializzazione. Il (lldb) mostra che il debugger è in esecuzione nel terminale, ora inserisci:

(lldb) run

Ora FreeCAD viene avviato. Effettuare le operazioni che causano il crash o il blocco di FreeCAD, quindi immettere 'bt' nella finestra del terminale.

(lldb) bt

Questo genera una lunga lista che descrive esattamente ciò che il programma stava facendo quando è andato in crash o in blocco. Includere questa lista nel vostro rapporto sul problema.

Ecco un esempio dell'uso di "Winpdb" all'interno di FreeCAD:

E' necessario il debugger di Python: "Winpdb". Se non lo è installato, su Ubuntu/Debian installarlo con:

sudo apt-get install winpdb

Questo consente di impostare il debugger.

1. Start Winpdb.
2. Impostare la password del debugger su "test": andare al menu "File" → "Password" e impostare la password.

Ora si esegua uno script Python di prova in FreeCAD passo dopo passo.

1. Eseguire winpdb e impostare la password (ad esempio test)
2. Creare un file Python con questo contenuto

import rpdb2
rpdb2.start_embedded_debugger("test")
import FreeCAD
import Part
import Draft
print "hello"
print "hello"
import Draft
points=[FreeCAD.Vector(-3.0,-1.0,0.0),FreeCAD.Vector(-2.0,0.0,0.0)]
Draft.makeWire(points,closed=False,face=False,support=None)

1. Avviare FreeCAD e caricare il file precedente in FreeCAD.
2. Premere F6 per eseguirlo.
3. Ora FreeCAD non risponde perché il debugger Python è in attesa
4. Passare alla GUI di Windpdb e cliccare su "Attach". Dopo pochi secondi appare una voce "<Input>" su cui si deve fare doppio clic.
5. Ora in Winpdb viene visualizzato lo script attualmente in esecuzione.
6. Impostare un break nell'ultima riga e premere F5.
7. Ora premere F7 per entrare nel codice Python di Draft.makeWire

Prerequisiti:

• Il pacchetto ptvsd deve essere installato in un Python 3 al di fuori di FreeCAD, quindi il modulo deve essere copiato nella cartella della libreria Python di FreeCAD.

# In a cmd window that has a path to you local Python 3:
pip install ptvsd
# Then if your Python is installed in C:\Users\<userid>\AppData\Local\Programs\Python\Python37
# and your FreeCAD is installed in C:\freecad\bin
xcopy "C:\Users\<userid>\AppData\Local\Programs\Python\Python37\Lib\site-packages\ptvsd" "C:\freecad\bin\Lib\site-packages\ptvsd"

pypi page

Documentazione di Visual Studio Code per il debug remoto

Passi:

• Aggiungere il seguente codice all'inizio dello script

import ptvsd
print("Waiting for debugger attach")
# 5678 is the default attach port in the VS Code debug configurations
ptvsd.enable_attach(address=('localhost', 5678), redirect_output=True)
ptvsd.wait_for_attach()

• Aggiungere una configurazione di debug nel codice di Visual Studio Debug → Aggiungi configurazioni ....
• La configurazione dovrebbe assomigliare a questa:

    "configurations": [
        {
            "name": "Python: Attacher",
            "type": "python",
            "request": "attach",
            "port": 5678,
            "host": "localhost",
            "pathMappings": [
                {
                    "localRoot": "${workspaceFolder}",
                    "remoteRoot": "."
                }
            ]
        },

• In VS Code aggiungere un breakpoint dove si desidera.
• Avviare lo script in FreeCAD. FreeCAD si blocca in attesa dell'allegato.
• In VS Code avviare il debug, utilizzando la configurazione creata. Si dovrebbero vedere le variabili nell'area del debugger.
• Quando si impostano i punti di interruzione, VS Code segnalerà di non trovare il file .py aperto nell'editor di VS Code.
  • Cambiare "remoteRoot": "." to "remoteRoot": "<directory del file>"
    • Ad esempio, se il file Python risiede in /home/FC_myscripts/myscript.py
    • Cambiare in: "remoteRoot": "/home/FC_myscripts"
  • Se si sta solo eseguendo il debug delle macro di FreeCAD dalla cartella delle macro di FreeCAD e quella cartella è "C:/Users/<userid>/AppData/Roaming/FreeCAD/Macro", usare:
    • "localRoot": "C:/Users/<userid>/AppData/Roaming/FreeCAD/Macro",
    • "remoteRoot": "C:/Users/<userid>/AppData/Roaming/FreeCAD/Macro"
• Se la macro non riesce a trovare ptvsd nonostante l'abbia installata da qualche parte, far precedere 'import ptvsd' con

from sys import path
sys.path.append('/path/to/site-packages')

Dove si trova il percorso della directory in cui è stato installato ptvsd.

• Sul bordo in basso a sinistra di VSCode si può scegliere l'eseguibile Python: è meglio impostarlo alla versione installata con FreeCAD.

Nel package Mac è /Applications/FreeCAD.App/Contents/Resources/bin/python.

E' possibile individuarlo sul proprio sistema digitando

import sys
print(sys.executable)

nella console Python di FreeCAD.

• Estrarre AppImage.

> ./your location/FreeCAD_xxx.AppImage --appimage-extract
> cd squashfs-root/

• La posizione sqashfs-root è il punto in cui il debugger viene successivamente collegato.

• Assicurarsi di poter avviare una sessione di FreeCAD dalla posizione squashfs-root.

squashfs-root> ./usr/bin/freecadcmd

• Si dovrebbe avviare una sessione della riga di comando di FreeCAD.

• Installare [1].
  • Viene fornito pronto con pydev e dispone di programmi di installazione per tutte le piattaforme.
  • Per Linux è sufficiente estrarlo (in qualsiasi posizione) ed eseguire.

• Configurare liclipse per il debug.
  • Fare clic con il pulsante destro del mouse sull'icona pydev (angolo in alto a destra) e scegli Personalizza.
    • Attivare "PyDev Debug" (tramite la casella di controllo, oppure potrebbe essere necessario andare alla scheda "Disponibilità set di azioni" e attivarla prima).
    • Nel menu pydev scegliere "start debug server".
  • Usare finestra menu/apri prospettiva/altro > debug.
    • Fai clic con il pulsante destro del mouse sull'icona di debug (angolo in alto a destra) e scegliere Personalizza.
    • Selezionando "Debug" vengono visualizzati gli strumenti di navigazione di debug nella barra degli strumenti.
  • Aprire le preferenze tramite la finestra del menu/preferenze.
    • In PyDev/Interpreters aggiungere "nuovo interprete navigando".
    • L'interprete aggiunto dovrebbe essere: your loc/squashfs-root/usr/bin/python.
    • Se si sta usando solo per fc, si possono aggiungere anche le cartelle del workbench AddOn o farlo in un progetto pydev in seguito.

• Trovare il percorso per pydevd.py nella tua installazione di liclipse.
  • Qualcosa sulla falsariga di: your location/liclipse/plugins/org.python.pydev.xx/pysrc.
• Creare un normale progetto pydev in liclipse.
  • Importare fonti esterne, ad esempio una macro di cui si desidera eseguire il debug o un workbench esterno.
  • In quella macro (o file .py del workbench) aggiungere le righe di codice:

import sys; sys.path.append("path ending with /pysrc")
import pydevd; pydevd.settrace()

• Questo è il punto in cui l'esecuzione si fermerà quando viene eseguita la macro.

• Avviare il server di debug liclipse (menu pydev).

• Avviare FreeCAD.

squashfs-root> ./usr/bin/freecad

• Eseguire la macro (o qualsiasi altro file con un trigger pydevd.settrace()) da freecad, come si farebbe normalmente.

• Buon debug.

• L'uso di LiClipse per il debug remoto e i passaggi qui descritti relativi a liclipse dovrebbero funzionare su qualsiasi piattaforma. Le parti relative ad AppImage sono solo per Linux.